Expand description

Amazon Web Services Secrets Manager

Amazon Web Services Secrets Manager provides a service to enable you to store, manage, and retrieve, secrets.

This guide provides descriptions of the Secrets Manager API. For more information about using this service, see the Amazon Web Services Secrets Manager User Guide.

API Version

This version of the Secrets Manager API Reference documents the Secrets Manager API version 2017-10-17.

For a list of endpoints, see Amazon Web Services Secrets Manager endpoints.

Support and Feedback for Amazon Web Services Secrets Manager

We welcome your feedback. Send your comments to awssecretsmanager-feedback@amazon.com, or post your feedback and questions in the Amazon Web Services Secrets Manager Discussion Forum. For more information about the Amazon Web Services Discussion Forums, see Forums Help.

Logging API Requests

Amazon Web Services Secrets Manager supports Amazon Web Services CloudTrail, a service that records Amazon Web Services API calls for your Amazon Web Services account and delivers log files to an Amazon S3 bucket. By using information that's collected by Amazon Web Services CloudTrail, you can determine the requests successfully made to Secrets Manager, who made the request, when it was made, and so on. For more about Amazon Web Services Secrets Manager and support for Amazon Web Services CloudTrail, see Logging Amazon Web Services Secrets Manager Events with Amazon Web Services CloudTrail in the Amazon Web Services Secrets Manager User Guide. To learn more about CloudTrail, including enabling it and find your log files, see the Amazon Web Services CloudTrail User Guide.

Crate Organization

The entry point for most customers will be Client. Client exposes one method for each API offered by the service.

Some APIs require complex or nested arguments. These exist in model.

Lastly, errors that can be returned by the service are contained within error. Error defines a meta error encompassing all possible errors that can be returned by the service.

The other modules within this crate are not required for normal usage.

Examples

Examples can be found here.

Modules

Client and fluent builders for calling the service.
Configuration for the service.
Endpoint resolution functionality
All error types that operations can return. Documentation on these types is copied from the model.
Input structures for operations. Documentation on these types is copied from the model.
Base Middleware Stack
Data structures used by operation inputs/outputs. Documentation on these types is copied from the model.
All operations that this crate can perform.
Output structures for operations. Documentation on these types is copied from the model.
Paginators for the service
Data primitives referenced by other data types.

Structs

App name that can be configured with an AWS SDK client to become part of the user agent string.
Client for AWS Secrets Manager
Service config.
AWS SDK Credentials
EndpointDeprecated
API Endpoint
The region to send requests to.

Enums

All possible error types for this service.

Statics

Crate version number.